fix(docs): Handle malformed YAML frontmatter gracefully - #1268
Merged
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
tanstack-com | 8fe5533 | Commit Preview URL Branch Preview URL |
Sep 12 2026, 11:03 AM |
TkDodo
approved these changes
Sep 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR addresses an issue where malformed YAML frontmatter in remote documentation files would cause a
YAMLParseError, leading to crashes during page loading and manifest generation.The
parseFrontMatterfunction insrc/utils/documents.server.tsnow includes a try/catch block around theparseYamlcall. If aYAMLParseErroroccurs, it will log a warning to the console and return a fallback object{ content: body, data: {} }. This ensures that the application can gracefully handle invalid frontmatter by serving the document's body content without metadata, preventing crashes and maintaining application stability. This approach is consistent with howparseFrontMatteralready handles other cases of unusable frontmatter (e.g., missing delimiters).Fixes TANSTACK-COM-50Z
This PR was automatically generated by Sentry. You can adjust this setting at any time.